Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Quarkus rules for the Vale linter: Fix false positive messages and enhance regular expression of some rules #35092

Merged
merged 1 commit into from
Aug 7, 2023
Merged

Quarkus rules for the Vale linter: Fix false positive messages and enhance regular expression of some rules #35092

merged 1 commit into from
Aug 7, 2023

Conversation

michelle-purcell
Copy link
Contributor

@michelle-purcell michelle-purcell commented Jul 28, 2023 •
edited
Loading

The PR contains fixes and enhancements to the Vale linter rules for Quarkus, including:

  • Adds exceptions for the following proper noun (product, service, component or other names) to the spelling, headings, and in some cases where needed the case-sensitive terms rules:
    • datasources
    • deserialized/Deserialized
    • Fluentd
    • Graylog
    • Istio (service mesh)
    • JBoss Logging
    • Logstash
    • syslog/Syslog
    • OTel (the correct abbreviation for OpenTelemetry)
  • Works around a vale bug in heading capitalization rules with terms xDS and gRPC.
  • Improves the regular expression for detecting non-compliance to the Oxford comma rule and some other fixes leveraged from the vale-at-red-hat repo
  • Removes some low-priority grammar rules that were flagged as churn by some community members

@quarkus-bot quarkus-bot bot added area/dependencies Pull requests that update a dependency file area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/docstyle issues related for manual docstyle review area/documentation labels Jul 28, 2023
@michelle-purcell michelle-purcell force-pushed the july-vale-rule-tweaks branch 2 times, most recently from 04588b7 to 864cce7 Compare July 28, 2023 18:36
@quarkus-bot quarkus-bot bot added area/hibernate-validator Hibernate Validator area/oidc area/platform Issues related to definition and interaction with Quarkus Platform labels Jul 28, 2023
@michelle-purcell
Copy link
Contributor Author

michelle-purcell commented Jul 28, 2023 •
edited
Loading

@rolfedh , @sheilamjones , @MichalMaler , @inoxx03 , @sunayna15 , @gsmet, @maxandersen, @cescoffier et other folks in the community who have raised issues with some of the Quarkus rules for Vale: If you can think of any other false positives that Vale flags on Quarkus content, please add the details and I can get them into this PR. Thanks 💚

@github-actions
Copy link

🎊 PR Preview 01fd090 has been successfully built and deployed to https://quarkus-pr-main-35092-preview.surge.sh/version/main/guides/

@quarkus-bot

This comment has been minimized.

Sign in to view
@MichalMaler
Copy link
Contributor

@michelle-purcell Great effort on this! It looks good.
Thank you also for adding the feedback from the Logging guide. Will have a look on Datasource too and will let you know, or create a solo PR for it.
Cheers!

@quarkus-bot

This comment has been minimized.

Sign in to view
@michelle-purcell michelle-purcell force-pushed the july-vale-rule-tweaks branch 2 times, most recently from ed272ab to 264209b Compare August 1, 2023 07:24
@quarkus-bot

This comment has been minimized.

Sign in to view
@rolfedh
Copy link
Contributor

rolfedh commented Aug 1, 2023

LGTM.

@michelle-purcell
Copy link
Contributor Author

@ebullient / @gsmet - Are you happy to merge these changes into main? Thanks

@michelle-purcell
Reducing vale doc linter style false positives
ae6ff6a 
Fixed false positives flagged in PRs with label.

remove definitions

Removed duplicates

removed duplicate

Add OTel to spelling
@quarkus-bot
Copy link

quarkus-bot bot commented Aug 4, 2023

✔️ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

@ebullient ebullient merged commit 0ae1395 into quarkusio:main Aug 7, 2023
20 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.3 - main milestone Aug 7, 2023
@michelle-purcell
Copy link
Contributor Author

@ebullient - Thank you 💚

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ebullient ebullient ebullient approved these changes

@MichalMaler MichalMaler MichalMaler approved these changes

Assignees
No one assigned
Labels
area/dependencies Pull requests that update a dependency file area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/docstyle issues related for manual docstyle review area/documentation area/health area/hibernate-validator Hibernate Validator area/oidc area/platform Issues related to definition and interaction with Quarkus Platform area/reactive-messaging area/smallrye area/testing area/tracing area/vertx
Projects
None yet
Milestone
3.3.0.CR1
Development

Successfully merging this pull request may close these issues.
4 participants
@michelle-purcell @MichalMaler @rolfedh @ebullient